home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cgbrfs.z / cgbrfs
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGBRFS - improve the computed solution to a system of linear equations
  10.      when the coefficient matrix is banded, and provides error bounds and
  11.      backward error estimates for the solution
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CGBRFS( TRANS, N, KL, KU, NRHS, AB, LDAB, AFB, LDAFB, IPIV, B,
  15.                         LDB, X, LDX, FERR, BERR, WORK, RWORK, INFO )
  16.  
  17.          CHARACTER      TRANS
  18.  
  19.          INTEGER        INFO, KL, KU, LDAB, LDAFB, LDB, LDX, N, NRHS
  20.  
  21.          INTEGER        IPIV( * )
  22.  
  23.          REAL           BERR( * ), FERR( * ), RWORK( * )
  24.  
  25.          COMPLEX        AB( LDAB, * ), AFB( LDAFB, * ), B( LDB, * ), WORK( *
  26.                         ), X( LDX, * )
  27.  
  28. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  29.      These routines are part of the SCSL Scientific Library and can be loaded
  30.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  31.      directs the linker to use the multi-processor version of the library.
  32.  
  33.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  34.      4 bytes (32 bits). Another version of SCSL is available in which integers
  35.      are 8 bytes (64 bits).  This version allows the user access to larger
  36.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  37.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  38.      only one of the two versions; 4-byte integer and 8-byte integer library
  39.      calls cannot be mixed.
  40.  
  41. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  42.      CGBRFS improves the computed solution to a system of linear equations
  43.      when the coefficient matrix is banded, and provides error bounds and
  44.      backward error estimates for the solution.
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      TRANS   (input) CHARACTER*1
  48.              Specifies the form of the system of equations:
  49.              = 'N':  A * X = B     (No transpose)
  50.              = 'T':  A**T * X = B  (Transpose)
  51.              = 'C':  A**H * X = B  (Conjugate transpose)
  52.  
  53.      N       (input) INTEGER
  54.              The order of the matrix A.  N >= 0.
  55.  
  56.      KL      (input) INTEGER
  57.              The number of subdiagonals within the band of A.  KL >= 0.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      KU      (input) INTEGER
  75.              The number of superdiagonals within the band of A.  KU >= 0.
  76.  
  77.      NRHS    (input) INTEGER
  78.              The number of right hand sides, i.e., the number of columns of
  79.              the matrices B and X.  NRHS >= 0.
  80.  
  81.      AB      (input) COMPLEX array, dimension (LDAB,N)
  82.              The original band matrix A, stored in rows 1 to KL+KU+1.  The j-
  83.              th column of A is stored in the j-th column of the array AB as
  84.              follows:  AB(ku+1+i-j,j) = A(i,j) for max(1,j-
  85.              ku)<=i<=min(n,j+kl).
  86.  
  87.      LDAB    (input) INTEGER
  88.              The leading dimension of the array AB.  LDAB >= KL+KU+1.
  89.  
  90.      AFB     (input) COMPLEX array, dimension (LDAFB,N)
  91.              Details of the LU factorization of the band matrix A, as computed
  92.              by CGBTRF.  U is stored as an upper triangular band matrix with
  93.              KL+KU superdiagonals in rows 1 to KL+KU+1, and the multipliers
  94.              used during the factorization are stored in rows KL+KU+2 to
  95.              2*KL+KU+1.
  96.  
  97.      LDAFB   (input) INTEGER
  98.              The leading dimension of the array AFB.  LDAFB >= 2*KL*KU+1.
  99.  
  100.      IPIV    (input) INTEGER array, dimension (N)
  101.              The pivot indices from CGBTRF; for 1<=i<=N, row i of the matrix
  102.              was interchanged with row IPIV(i).
  103.  
  104.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  105.              The right hand side matrix B.
  106.  
  107.      LDB     (input) INTEGER
  108.              The leading dimension of the array B.  LDB >= max(1,N).
  109.  
  110.      X       (input/output) COMPLEX array, dimension (LDX,NRHS)
  111.              On entry, the solution matrix X, as computed by CGBTRS.  On exit,
  112.              the improved solution matrix X.
  113.  
  114.      LDX     (input) INTEGER
  115.              The leading dimension of the array X.  LDX >= max(1,N).
  116.  
  117.      FERR    (output) REAL array, dimension (NRHS)
  118.              The estimated forward error bound for each solution vector X(j)
  119.              (the j-th column of the solution matrix X).  If XTRUE is the true
  120.              solution corresponding to X(j), FERR(j) is an estimated upper
  121.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  122.              divided by the magnitude of the largest element in X(j).  The
  123.              estimate is as reliable as the estimate for RCOND, and is almost
  124.              always a slight overestimate of the true error.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))                                                          CCCCGGGGBBBBRRRRFFFFSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      BERR    (output) REAL array, dimension (NRHS)
  141.              The componentwise relative backward error of each solution vector
  142.              X(j) (i.e., the smallest relative change in any element of A or B
  143.              that makes X(j) an exact solution).
  144.  
  145.      WORK    (workspace) COMPLEX array, dimension (2*N)
  146.  
  147.      RWORK   (workspace) REAL array, dimension (N)
  148.  
  149.      INFO    (output) INTEGER
  150.              = 0:  successful exit
  151.              < 0:  if INFO = -i, the i-th argument had an illegal value
  152.  
  153. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  154.      ITMAX is the maximum number of steps of iterative refinement.
  155.  
  156. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  157.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  158.  
  159.      This man page is available only online.
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.